package j_util.data_structures.stack;
/*

    This file is part of Logica-Logike.

    Logica-Logike is free software: you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License as published by
    the Free Software Foundation version 3 of the License.

    Logica-Logike is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public License
    along with Logica-Logike.  If not, see <http://www.gnu.org/licenses/>.

 */
/**
 * This interface shows most important stack methods;
 *
 * @author Jose Martin Rozanec;
 */
public interface StackInterface {
    /**
     * This method allows to know if StackInterface is empty;
     *
     * @return boolean - true if empty, false if not;
     */
    boolean isEmpty();

    /**
     * This method allows to see the top Object in a StackInterface;
     *
     * @return top - Object;
     */
    Object top();

    /**
     * This method takes out the las element in a StackInterface;
     */
    void pop();

    /**
     * This method allows pushing a new element into StackInterface;
     *
     * @param o - Object;
     */
    void push(Object o);
}
